home *** CD-ROM | disk | FTP | other *** search
- riphelp by Mark H. Wilkinson (C) 1993
- This version: 13feb93
-
- Description:
-
- This is a simple program to build HelpData and Index files
- for StrongHelp v 1.00, the help system which accompanies
- StrongED II v 1.10. It extracts the help text for the
- standard C library from the Desktop C !SrcEdit program and
- also allows other help pages to be added. You may find it
- useful if you program in C and hate !SrcEdit.
-
-
- Instructions for use:
-
- 1. Compile riphelp. There's a simple Makefile included to
- do this.
- 2. Load !StrongHlp.
- 3. Go to the !StrongHlp application directory and create a
- new directory called "C" in the HelpData directory (i.e.
- create "<StrongHelp$Dir>.HelpData.C")
- 4. Load !SrcEdit; quit it again if you want. (This is
- needed to get SrcEdit$Dir set properly.)
- 5. Run riphelp.
- 6. Quit StrongHelp and restart it again.
- 7. Modify the MainMenu page from StrongHelp to include a
- link to the root of the C help system (you need to add a
- line saying "<C =>C.$>" onto the page).
- 8. Select "Save Help" on StrongHelp's icon bar menu to save
- the change to MainMenu.
- 9. Enjoy instant help on all standard library routines and
- definitions. (And a one page summary of all the operators
- and their precedence and associativity.)
- 10. Write extra pages for the things you think are missing
- and send them to me for inclusion in the next release!
-
-
- How to add your own pages:
-
- Create a file in the c directory and type your text in
- there. Follow the format of the entry in c.operators - the
- text is an initialiser for an array in the main program so
- don't forget the commas and quote marks or the compiler
- will complain.
-
- The first entry is the name of the page in the index. Use
- something descriptive and long enough to avoid name clashes.
-
- The second entry indicates whether the name can be searched
- for by pressing F1 in StrongED and should be either YES or
- NO.
-
- The third entry is the text for the help page. The first
- line appears in the title bar of the help window and the
- rest appears in the window itself.
-
- You can include link words in the help text following the
- syntax described in the StrongHelp documentation. Ensure
- you double all backslashes to get them through the compiler
- intact.
-
-
- The next version:
-
- Hopefully will include more information about the C
- language (keywords, types and such). I've already started
- doing this, but the text I have is based heavily on K&R and
- probably shouldn't be distributed.
-
- May also attempt to automatically cross reference the
- library help.
-
-
- Contact me:
-
- Send modifications and stuff to me as mhw@minster.york.ac.uk
-